<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>examples &mdash; GOZERWAVE v0.1 BETA documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '0.1 BETA',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="GOZERWAVE v0.1 BETA documentation" href="../index.html" />
    <link rel="next" title="less" href="less.html" />
    <link rel="prev" title="eventbase" href="eventbase.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="less.html" title="less"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="eventbase.html" title="eventbase"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">GOZERWAVE v0.1 BETA documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="examples">
<h1>examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-gozerlib.examples">
<h2>description<a class="headerlink" href="#module-gozerlib.examples" title="Permalink to this headline">¶</a></h2>
<p>examples is a dict of example objects.</p>
<dl class="class">
<dt id="gozerlib.examples.Example">
<em class="property">class </em><tt class="descclassname">gozerlib.examples.</tt><tt class="descname">Example</tt><big>(</big><em>descr</em>, <em>ex</em><big>)</big><a class="headerlink" href="#gozerlib.examples.Example" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a title="(in Python v2.7)" class="reference external" href="http://docs.python.org/dev/library/functions.html#object"><tt class="xref docutils literal"><span class="pre">object</span></tt></a></p>
<p>an example.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>descr</em> (string) &#8211; description of the example</li>
<li><em>ex</em> (string) &#8211; the example</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="gozerlib.examples.Examples">
<em class="property">class </em><tt class="descclassname">gozerlib.examples.</tt><tt class="descname">Examples</tt><a class="headerlink" href="#gozerlib.examples.Examples" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a title="(in Python v2.7)" class="reference external" href="http://docs.python.org/dev/library/stdtypes.html#dict"><tt class="xref docutils literal"><span class="pre">dict</span></tt></a></p>
<p>examples holds all the examples.</p>
<dl class="method">
<dt id="gozerlib.examples.Examples.add">
<tt class="descname">add</tt><big>(</big><em>name</em>, <em>descr</em>, <em>ex</em><big>)</big><a class="headerlink" href="#gozerlib.examples.Examples.add" title="Permalink to this definition">¶</a></dt>
<dd><p>add description and example.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>name</em> (string) &#8211; name of the example</li>
<li><em>descr</em> (string) &#8211; description of the example</li>
<li><em>ex</em> (string) &#8211; the example</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="gozerlib.examples.Examples.getexamples">
<tt class="descname">getexamples</tt><big>(</big><big>)</big><a class="headerlink" href="#gozerlib.examples.Examples.getexamples" title="Permalink to this definition">¶</a></dt>
<dd><p>get all examples in list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">list</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="gozerlib.examples.Examples.size">
<tt class="descname">size</tt><big>(</big><big>)</big><a class="headerlink" href="#gozerlib.examples.Examples.size" title="Permalink to this definition">¶</a></dt>
<dd><p>return size of examples dict.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">integer</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="code">
<h2>code<a class="headerlink" href="#code" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python"><table class="highlighttable"><tr><td class="linenos"><pre> 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81</pre></td><td class="code"><div class="highlight"><pre><span class="c"># gozerlib/examples.py</span>
<span class="c">#</span>
<span class="c">#</span>

<span class="sd">&quot;&quot;&quot; examples is a dict of example objects. &quot;&quot;&quot;</span>

<span class="c">## basic imports</span>

<span class="kn">import</span> <span class="nn">re</span>

<span class="k">class</span> <span class="nc">Example</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>

    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        an example.</span>

<span class="sd">        :param descr: description of the example</span>
<span class="sd">        :type descr: string</span>
<span class="sd">        :param ex: the example</span>
<span class="sd">        :type ex: string</span>

<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">descr</span><span class="p">,</span> <span class="n">ex</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">descr</span> <span class="o">=</span> <span class="n">descr</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">example</span> <span class="o">=</span> <span class="n">ex</span>

<span class="k">class</span> <span class="nc">Examples</span><span class="p">(</span><span class="nb">dict</span><span class="p">):</span>

    <span class="sd">&quot;&quot;&quot; examples holds all the examples. &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">descr</span><span class="p">,</span> <span class="n">ex</span><span class="p">):</span>

        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">            add description and example.</span>

<span class="sd">            :param name: name of the example</span>
<span class="sd">            :type name: string</span>
<span class="sd">            :param descr: description of the example</span>
<span class="sd">            :type descr: string</span>
<span class="sd">            :param ex: the example</span>
<span class="sd">            :type ex: string</span>

<span class="sd">        &quot;&quot;&quot;</span>

        <span class="bp">self</span><span class="p">[</span><span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span> <span class="o">=</span> <span class="n">Example</span><span class="p">(</span><span class="n">descr</span><span class="p">,</span> <span class="n">ex</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">size</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">            return size of examples dict.</span>

<span class="sd">            :rtype: integer</span>

<span class="sd">        &quot;&quot;&quot;</span>

        <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>

    <span class="k">def</span> <span class="nf">getexamples</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">            get all examples in list.</span>

<span class="sd">            :rtype: list</span>

<span class="sd">        &quot;&quot;&quot;</span>

        <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>

        <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
            <span class="n">ex</span> <span class="o">=</span> <span class="n">i</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
            <span class="n">exampleslist</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;\d\)&#39;</span><span class="p">,</span> <span class="n">ex</span><span class="p">)</span>

            <span class="k">for</span> <span class="n">example</span> <span class="ow">in</span> <span class="n">exampleslist</span><span class="p">:</span>

                <span class="k">if</span> <span class="n">example</span><span class="p">:</span>
                    <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">example</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>

        <span class="k">return</span> <span class="n">result</span>

<span class="c"># main examples object</span>
<span class="n">examples</span> <span class="o">=</span> <span class="n">Examples</span><span class="p">()</span>
</pre></div>
</td></tr></table></div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3><a href="../index.html">Table Of Contents</a></h3>
            <ul>
<li><a class="reference external" href="">examples</a><ul>
<li><a class="reference external" href="#module-gozerlib.examples">description</a></li>
<li><a class="reference external" href="#code">code</a></li>
</ul>
</li>
</ul>

            <h4>Previous topic</h4>
            <p class="topless"><a href="eventbase.html"
                                  title="previous chapter">eventbase</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="less.html"
                                  title="next chapter">less</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="../_sources/gozerlib/examples.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="../search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="less.html" title="less"
             >next</a> |</li>
        <li class="right" >
          <a href="eventbase.html" title="eventbase"
             >previous</a> |</li>
        <li><a href="../index.html">GOZERWAVE v0.1 BETA documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2009, Bart Thate.
      Last updated on Nov 14, 2009.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.3.
    </div>
  </body>
</html>